home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Toolbox / Visual Basic Toolbox (P.I.E.)(1996).ISO / code_edt / scb10 / readme.txt < prev    next >
Text File  |  1995-10-27  |  8KB  |  186 lines
  1. SCOPER B.10
  2.  
  3. ELIMINATE DEAD CODE !
  4.  
  5. **************************************************************
  6. Recently reviewed in major VB publications ...
  7. **************************************************************
  8.  
  9. VB Tech Journal, 10/95 ...
  10.  
  11. "... it is wise to subject your projects to the scrutiny of
  12.      a cross-reference utility that analyzes the source code and
  13.      reports on unused variables and code - a utility like ISES
  14.      Inc.'s shareware Scoper."
  15.  
  16. "... Scoper can even create a new version of your project, with
  17.      the dead code stripped out, in a new directory."
  18.  
  19. "... this handy tool is well worth the $19 registration fee."
  20.     
  21. VB Programmer's Journal, 10/95
  22.  
  23. "... The new release adds online context sensitive help, a
  24.      cross reference analysis engine, in-flight binary-text
  25.      conversion, improved statistics drill-down software, and
  26.      element/scope/type protection filters during the auto-rewrite
  27.      process."
  28.  
  29. *****************************************************************    
  30.  
  31. SCOPER analyzes VB3 project source code and identifies variables,
  32. constants, function - subroutine declarations and code that are
  33. never used. 
  34.  
  35. Shareware users can use the SCOPER report to manually remove dead
  36. code in their VB3 projects.
  37.  
  38. Registered users can have SCOPER automatically rewrite their code
  39. (in a different directory) eliminating all unused elements. In a
  40. few seconds, the registered version will create a new copy of your
  41. project, including custom CONSTANT.TXT, WIN30API.TXT, VBSQL.BI, 
  42. etc. containing ONLY the elements your project needs.
  43.  
  44. Registered users can have SCOPER produce an optional cross
  45. reference report, filtered by any desired combination of scope and
  46. object type.
  47.  
  48. SCOPER requires the source modules to be saved as text. The 
  49. registered version will do an "in-flight" binary->text conversion 
  50. if the project contains any source that was saved as binary.
  51.  
  52. In the corporate development environment, use SCOPER as the final
  53. project check before production cutover. Make sure production
  54. .EXE's are not riddled with dead code and wasted space.
  55.  
  56. TO USE: Copy the SCOPER distribution files into any directory you
  57. wish. The files are:
  58.  
  59.         SCOPER.EXE
  60.         SCOPER.HLP
  61.         SPREAD20.VBX
  62.         QPRO200.DLL
  63.  
  64. 1. Execute SCOPER.EXE from windows. If you are using an evaluation
  65. copy Click "I AGREE" on the SCOPER evaluation form. If you are a 
  66. shareware user and wish to receive a registered copy of SCOPER, 
  67. click "ORDER FORM" or, go to the "How to Order a Registered Copy"
  68. section in the on-line help file. 
  69.  
  70. 2. From the SCOPER screen click SELECT PROJECT. Pick the project
  71. .MAK file you want analyzed. If SCOPER finds any binary source in 
  72. the project it will prompt you to save these modules as text.
  73. REGISTERED USERS: SCOPER will ask you if it should do an in-flight 
  74. binary->text conversion.
  75.  
  76. 3. SCOPER normally checks for unused elements of all combinations 
  77. of type and scope. If you want to filter this checking, click the 
  78. FILTER button to customize the type/scope combinations SCOPER 
  79. will look for. REGISTERED USERS: If you intend to use SCOPER's 
  80. VB XREF facilities after the run, check the "SAVE DATA FOR XREF" 
  81. box on the OPTIONS screen.
  82.  
  83. 4. Click SCOPER to start analysis. While running, SCOPER displays 
  84. two progress bars. The left bar represents progress for the source
  85. module currently being analyzed. The right bar displays progress 
  86. for the entire project. When SCOPER is done, the results can be 
  87. viewed as follows:
  88.  
  89. 5. Click PRINT if you want a hardcopy "DEAD CODE" report. 
  90.  
  91. 6. Click SAVE TO FILE to create a tab-delimited file of unused 
  92. elements suitable for importing into Excel, etc. 
  93.  
  94. 7. Click STATS to display interesting statistics about your 
  95. project. When the summary stats screen is displayed, you can 
  96. double-click on any filename to drill-down to more detailed 
  97. statistics about any form or module in the project.
  98.  
  99. 8. REGISTERED USERS: The "SELECT PATH" button will be enabled.
  100. Click this button to select the target directory for the new
  101. project source.
  102.  
  103. 9. REGISTERED USERS: Once the target path is selected, the
  104. "AUTO-REWRITE" button will be enabled. Click this button to have
  105. SCOPER create new source code for your project, automatically
  106. eliminating unused variables, constants, declarations, and dead
  107. code.
  108.  
  109. 10. REGISTERED USERS: If you checked the "SAVE DATA FOR XREF"
  110. checkbox, the "CROSS-REF" button will be enabled. Click this
  111. button to bring up the cross-reference form. Note that the
  112. cross-reference data can be filtered by any combination of 
  113. scope and object type using the check boxes on the bottom of the 
  114. form.
  115.  
  116. 11. If you want another project analyzed, return to step 2. If 
  117. not, click EXIT.
  118.  
  119. NOTES FOR REGISTERED USERS:
  120.  
  121. SCOPER will NOT modify any original source modules. The
  122. Auto-Rewrite process begins by copying everything from the
  123. original project directory into the target directory.  If any
  124. modules need to be re-written that were NOT in the original
  125. directory (e.g., CONSTANT.TXT is usually in the VB directory),
  126. SCOPER will write the new module in the target directory and
  127. modify the new project .MAK file accordingly.
  128.  
  129. Also, it is a good idea to run the rewritten project through
  130. SCOPER after the auto-rewrite process completes. This will catch
  131. situations where a module or global scope variable is only used in
  132. a routine that is never executed. SCOPER will eliminate the unused
  133. routine during the first rewrite, but the variable will remain 
  134. part of the project. When the rewritten project is run through 
  135. SCOPER, the variable will be identified as unused and will be 
  136. eliminated.
  137.  
  138. The above situation becomes very interesting when one considers
  139. the fact that it can involve an infinite number of dimensions.
  140. For example, suppose routine-A calls routine-B, and routine-B
  141. calls routine-C. Assume that routine-A is never called. On the
  142. first iteration, SCOPER will eliminate routine-A but not routine-B
  143. and routine-C. On the second iteration, SCOPER will eliminate
  144. routine-B (assuming it is not called by any other routines) but
  145. not routine-C. On the THIRD iteration, SCOPER will eliminate
  146. routine-C (assuming it is not called by any other routines). Thus,
  147. it is a good idea to SCOPE the project until it comes up "clean" 
  148. (no unused elements). 95% of the time, this will happen after the 
  149. first iteration.
  150.  
  151. A brief note on how the SCOPER rewrite engine handles recursion:
  152. If routine-A calls itself but is not called by another routine,
  153. SCOPER will eliminate routine-A since it is dead code. However, 
  154. if routine-A calls routine-B, and routine-B calls routine-A, 
  155. SCOPER will not eliminate either routine since both are, 
  156. technically speaking, referenced outside their own local scope.
  157.  
  158. WHAT'S NEW in Version B.10:
  159.  
  160. 1. A minor bug was causing problems when .MAK files contained the
  161. "..\" DOS path convention. This has been fixed.
  162.  
  163. 2. The on-line help documentation has been expanded and brought up
  164. to date on the new features added in the last three releases.
  165.  
  166. 3. The lexical analysis routines have been tuned so our users 
  167. should see a small but noticeable increase in speed during the
  168. analysis phase.
  169.  
  170. Please use U.S. Mail, Compuserve e:mail or fax to let us know what
  171. enhancements you would like to see in future SCOPER releases.
  172.  
  173. Thanks.
  174.  
  175. SCOPER Copyright(c) 1995 by ISES, Inc. ALL RIGHTS RESERVED
  176.  
  177. ISES, Inc.
  178. 102 Sunrise Drive
  179. Gillette, NJ 07933
  180.  
  181. Compuserve: 72417,627
  182. AOL: ISES INC
  183. Fax: 908-580-1008
  184. Voice: 1-800-447-ISES -or- 908-766-1894
  185.  
  186.